XIQS Update Allocation Rule
From IQsimWiki
XIQS Update Allocation Rule - Allocation Rule Management
Description |
---|
updateXIQSAllocRule ( Long id_allocrule , String name , Integer mode , String monday , String tuesday , String wednesday , String thursday , String friday , String saturday , String sunday , Long operator , Integer simmode , Integer simultaneous , Long simlease , Long callleasetime , Integer priority , Integer port , Long simchoice , Long id_portgrp , Long id_simselect , Long maxcalls , Integer conxcallonly , Integer forcereset , Integer changemaster , Integer useoffpeak , Integer usereal , Long simsleep , Long countdown , Integer complease , Integer smsallowed , Integer smsoffpeak , Integer timezone , Integer callkeeppending , [Integer resetrackpos] )
Update an existing Allocation Rule object which Id is specified |
Parameters |
---|
Long id_allocrule Allocation Rule Id String name Allocation Rule Name Integer mode Rule disabled flag: String monday Define the time period during which the given rule is valid or activated. Time schedule mask for Monday, string containing 24 digits, each corresponding to one hour, starting from 00 to 23 h; put '1' if Rule has to be active in both halfs of hour, '2' only in the first half, '3' only in the second half or '0' if Rule has to be deacivated in both halfs of hour String tuesday Time schedule mask for Tuesday, the same format as for Monday String wednesday Time schedule mask for Wednesday, the same format as for Monday String thursday Time schedule mask for Thursday, the same format as for Monday String friday Time schedule mask for Friday, the same format as for Monday String saturday Time schedule mask for Saturday, the same format as for Monday String sunday Time schedule mask for Sunday, the same format as for Monday Long operator GSM Network Operator PLMN (MCC+MNC) code; Only SIM cards of this provider will be used Integer simmode Sim choice mode (Mandatory): Integer simultaneous RESERVED FOR FUTURE USAGE Long simlease Maximal lease time (seconds); Maximal time that will a SIM card allocated by the given rule stay on the GSM port Long callleasetime Maximal calling time (seconds); Maximal calling time allowed on a SIM card before it will be deallocated Integer priority Priority level (1 to 9, 1 the highest priority); Allocation rules with lower priority will be only applicable if those with higher priority have no SIM cards available for allocation Integer port RESERVED FOR FUTURE USAGE Long simchoice SIM preference: Long id_portgrp Port Group Id; Only SIM cards from this Port group will be selected Long id_simsel Sim group Id / Price Plan Id; Only SIM cards from this Sim group or Price Plan will be selected Long maxcalls Maximal number of calls; Maximal number of calls allowed on SIM card before it will be deallocated Integer conxcallonly Connected calls only flag; Count only connected calls in MaxCalls Integer forcereset Force SIM deallocation; If checked, the allocated SIM card will be deallocated by Sim Manager from GSM ports whenever it swaps from peak to off-peak period or vice-versa. Such deallocations will be imposed even if SIM is used for the active call Integer changemaster Next allocation forced to another site; If checked SIM card will be forbidden from being allocated twice consecutive to the GSM port on the same Gateway Integer useoffpeak Allocation call billing period; Determine if the billing increment of the given allocation rule is peak, off-peak or bonus value: Integer usereal Callleasetime type, Billing or Real time: Long simsleep Minimal sleeping/traveling time (seconds); The minimal time that the Sim Manager will force SIM card to stay unallocated in sleeping or traveling state, after it is deallocated from GSM port Long countdown Start SIM change in advance (seconds); Deallocate SIM cards ahead of their scheduled release time Integer complease Force to complete time flag Integer smsallowed Allocation route allowed for: Integer smsoffpeak Allocation SMS billing period: Integer timezone Time Zone Id; Time Zone for the times in Activated Period table (see Timezone table) Integer callkeeppending - [Integer resetrackpos] When enabled (=1) Here is how Sim Selection by Sim Rack is implemented: if Sims are selected by Sim Rack, it means that first sim allocated by this rule will be in the first simrack (database id order), first board and first position on Board. Then second position and so on. |
Return Values |
---|
Structure ReturnCode ' - Integer: OK = 1 Error Data structure ( Error Management ) Possible failure code returns |
See Also |
---|